III. File Storage Commands

The filestorage command node is used to manage virtual file systems (VFSs), mirrors, and the VFS Scheduler. The filestorage command node includes the following subnodes:

  • backup

  • mirror

  • scheduler

  • vfs

Each of the commands is described in detail, with parameters and arguments listed for each command.

Table of Contents
File Storage Backup Command —
filestorage backup show — Use the filestorage backup show command to display information about backup operations for one or more VFSs.
File Storage Mirror Commands —
filestorage mirror delete — Use the filestorage mirror delete command to remove a mirrored VFS from the mirror group and to delete a VFS mirror.
filestorage mirror new — Use the filestorage mirror new command to add a storage pool to the mirror group.
filestorage mirror replicate — Use the filestorage mirror replicate command to replicate a VFS to each storage pool in the mirror group.
filestorage mirror show — Use the filestorage mirror show command to display information about mirrored VFSs.
filstorage mirror show-group — Use the filestorage mirror show-group command to display information about the mirrors associated with a particular source VFS.
File Storage Scheduler Commands —
File Storage Scheduler Jobs Commands —
filestorage scheduler jobs cleanup — Use the filestorage scheduler jobs cleanup command to remove SpinShots and mirror replicas associated with a specified VFS Scheduler job.
filestorage scheduler jobs delete — Use the filestorage scheduler jobs delete command to delete a VFS Scheduler job.
filestorage scheduler jobs modify — Use the filestorage scheduler jobs modify command to modify a VFS Scheduler job.
filestorage scheduler jobs new — Use the filestorage scheduler jobs new command to create a VFS Scheduler job.
filestorage scheduler jobs show — Use the filestorage scheduler jobs show command to display information about VFS Scheduler jobs.
filestorage scheduler jobs testrun — Use the filestorage scheduler jobs testrun command to run a test of a VFS Scheduler job immediately, without having to wait for the next scheduled time interval.
File Storage Scheduler Schedules Commands —
filestorage scheduler schedules delete — Use the filestorage scheduler schedules delete command to delete a VFS Scheduler schedule.
filestorage scheduler schedules modify — Use the filestorage scheduler schedules modify command to modify a VFS Scheduler schedule.
filestorage scheduler schedules new — Use the filestorage scheduler schedules new command to create a VFS Scheduler schedule.
filestorage scheduler schedules show — Use the filestorage scheduler schedules show command to display information about VFS Scheduler schedules.
File Storage Scheduler Tasks Commands —
filestorage scheduler tasks cleanup — Use the filestorage scheduler tasks cleanup command to delete all SpinShots or mirror replicas created by a VFS Scheduler task.
filestorage scheduler tasks delete — Use the filestorage scheduler tasks delete command to delete a VFS Scheduler task.
filestorage scheduler tasks modify — Use the filestorage scheduler tasks modify command to modify a VFS Scheduler task.
filestorage scheduler tasks new — Use the filestorage scheduler tasks new command to create a VFS Scheduler task.
filestorage scheduler tasks show — Use the filestorage scheduler tasks show command to display information about VFS Scheduler tasks.
File Storage VFS Commands —
filestorage vfs copy — Use the filestorage vfs copy command to copy an existing virtual file system (VFS).
filestorage vfs delete — Use the filestorage vfs delete command to delete a virtual file system.
filestorage vfs modify — Use the filestorage vfs modify command to modify the minimum quota, maximum quota, user type, domain, user, or group of an existing virtual file system.
filestorage vfs mount — Use the filestorage vfs mount command to mount a virtual file system.
filestorage vfs move — Use the filestorage vfs move command to move an existing virtual file system (VFS).
filestorage vfs new — Use the filestorage vfs new command to create a new virtual file system.
filestorage vfs resetexportruleset — Use the filestorage vfs resetexportruleset command to change the export rule set on a virtual file system (VFS) and to change the export rule set recursively down a chain of virtual file systems (VFSs).
filestorage vfs show — Use the filestorage vfs show command to display configuration details of a virtual file system.
filestorage vfs show-access — Use the filestorage vfs show-access command to display information about export rule sets for one or more virtual file systems (VFSs).
filestorage vfs show-all — Use the filestorage vfs show-all command to display a listing of all virtual file systems (VFSs), including read-only VFSs such as SpinShots and mirrors.
filestorage vfs show-family — Use the filestorage vfs show-family command to display the read-only virtual file systems (VFSs), such as SpinShots and mirrors, that are associated with a read-write virtual file system.
filestorage vfs show-mount — Use the filestorage vfs show-mount command to display mount-path information for a specific virtual file system or for all virtual file systems.
filestorage vfs show-virusscan — Use the filestorage vfs show-virusscan command to display information about virus scanning for one or more VFSs.
filestorage vfs show-vs — Use the filestorage vfs show-vs command to display virtual server information for a specific VFS or for all VFSs.
filestorage vfs spinshot — Use the filestorage vfs spinshot command to create a one-time SpinShot of an existing virtual file system (VFS).
filestorage vfs unmount — Use the filestorage vfs unmount command to unmount a virtual file system.

File Storage Backup Command

Name

File Storage Backup Command -- 

The filestorage backup subnode includes the show command.


filestorage backup show

Name

filestorage backup show -- Use the filestorage backup show command to display information about backup operations for one or more VFSs.

Synopsis

CLI:

filestorage backup show [-vfsname VFS_name]

GUI: Navigate to the File Storage → Backup node. To display backup information about a specific VFS, select it from the table and run the Show command from the drop-down menu in the action pane.

Description

The filestorage backup show command displays information about backup operations for all VFSs or for a specified VFS. The information includes the following:

Use the command with no argument to display information about all VFSs, or with the -vfsname argument to display information about a specific VFS.

Options

[-vfsname VFS_name]

This is the name of the VFS for which backup information is to be displayed.

Example

The following example displays backup information about all VFSs:

spinserver::> filestorage backup show 

VFS              Last Backup        Last Full Backup  
                                                              
root.vs0             n/a                  n/a                 
vs0.vfs0             n/a                  n/a                 
vs0.vfs1             n/a                  n/a                 

File Storage Mirror Commands

Name

File Storage Mirror Commands -- 

The filestorage mirror subnode includes the following commands:

Note: Mirroring requires the SpinMirror™ software package, which is licensed separately from the base SpinFS software package.


filestorage mirror delete

Name

filestorage mirror delete -- Use the filestorage mirror delete command to remove a mirrored VFS from the mirror group and to delete a VFS mirror.

Synopsis

CLI:

filestorage mirror delete -sourcevfsname source_VFS_name -sinkvfsname sink_VFS_name

GUI: Navigate to the File Storage → Mirrors node, then select the appropriate mirror from the table and run the Delete command from the drop-down menu of the action pane.

Description

The filestorage mirror delete command removes a mirrored VFS from the mirror group and deletes its VFS mirror.

Caution:

If you have a VFS that is mirrored to two storage pools and you want to delete one of the mirrors, ensure that all mirrors are replicated immediately before deleting any mirrors, or otherwise ensure that all mirrors are synchronized with the source VFS before deleting any mirrors. This prevents clients from receiving potentially out-of-date date from an obsolete mirror.

Options

-sourcevfsname source_VFS_name

This is the name of the mirrored VFS that is to be removed from the mirror group and have its VFS mirror deleted.

-sinkvfsname sink_VFS_name

This is the name of the VFS mirror that is to be deleted.

Example

The following example deletes a mirror named vfs1_m1 of a VFS named vfs1:

spinserver::> filestorage mirror delete -sourcevfsname vfs1 -sinkvfsname vfs1_m1

filestorage mirror new

Name

filestorage mirror new -- Use the filestorage mirror new command to add a storage pool to the mirror group.

Synopsis

CLI:

filestorage mirror new -sourcevfsname source_VFS_name -sinkvfsname mirror_VFS_name -sinkspname storage_pool_name

GUI: Navigate to the File Storage → Mirrors node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed and click Create.

Description

The filestorage mirror new command adds a storage pool to the mirror group and creates an empty VFS on the target storage pool. The status of the mirror VFS is initially set to offline. After the mirror VFS is created, use the filestorage mirror replicate command to replicate data from the source VFS to the mirror VFS; this command also sets the status of the mirror VFS to online.

Options

-sourcevfsname VFS_name

This is the name of the source VFS.

-sinkvfsname mirror_VFS_name

This is the name of the new mirror VFS.

-sinkspname storage_pool_name

This is the name of the storage pool on which the new mirror is to be created.

Example

The following example creates an empty mirror VFS named vfs1_m1 on a storage pool named pool0; the mirror is of a source VFS named vfs1.

spinserver::> filestorage mirror new -sourcevfsname vfs1 -sinkvfsname vfs1_m1 -sinkspname pool0

filestorage mirror replicate

Name

filestorage mirror replicate -- Use the filestorage mirror replicate command to replicate a VFS to each storage pool in the mirror group.

Synopsis

CLI:

filestorage mirror replicate -sourcevfsname source_VFS_name -sinkvfsname sink_VFS_name -maxspinshots number_of_replicas

GUI: Navigate to the File Storage → Mirror node, then select the appropriate mirror from the table and run the Replicate command from the drop-down menu of the action pane.

Description

The filestorage mirror replicate command replicates a VFS to each storage pool in the mirror group. Use this command both for the initial replication of a mirror and for subsequent manual updates. When a mirror is replicated, only the data that has changed since the last replication is propagated to the mirror.

When this command is used to replicate a new mirror, it sets the status of the mirror from offline to online.

Options

-sourcevfsname source_VFS_name

This is the name of the source VFS.

-sinkvfsname sink_VFS_name

This is the name of the VFS mirror that is to be replicated.

-maxspinshots number_of_replicas

This specifies the number of mirror replicas to retain. When the specified number is reached, the oldest replica is deleted as each new replica is created. The default value is 1.

Example

The following example replicates a source VFS named vfs1 to a mirror named vfs1_m1. The number of replicas retained is 3.

spinserver::> filestorage mirror replicate -sourcevfsname vfs1 -sinkvfsname vfs1_m1 -maxspinshots 3

filestorage mirror show

Name

filestorage mirror show -- Use the filestorage mirror show command to display information about mirrored VFSs.

Synopsis

CLI:

filestorage mirror show [-sourcevfsname source_VFS_name -sinkvfsname sink_VFS_name]

GUI: Navigate to the File Storage → Mirror node. To display information about a specific mirror, select it from the table and run the Show command from the drop-down menu in the action pane.

Description

The filestorage mirror show command displays information about all mirrored VFSs or for a specified mirrored VFS. The information includes the following:

Use the command with no argument to display information about all mirrored VFSs, or with the -vfsname argument to display information about a specific mirrored VFS.

Options

[-sourcevfsname source_VFS_name]

This is the name of the mirrored VFS for which information is to be displayed.

[-sinkvfsname sink_VFS_name]

This is the name of the VFS mirror for which information is to be displayed.

Example

The following example displays information about a VFS mirror named san.m1 whose source VFS is named san:

spinserver::> filestorage mirror show -sourcevfsname san -sinkvfsname san.m1
   Source VFS         san                                     
   Sink VFS           san.m1                                  
   Source SP          pool0                              
   Sink SP            pool1                              
   Source VFS ID      419407                                  
   Sink VFS ID        1074161231                              
   Sink Create Time   09/22/2004 9:30 AM                      
   Sink Vers          2550018                                 
   Status             online                                  

filstorage mirror show-group

Name

filstorage mirror show-group -- Use the filestorage mirror show-group command to display information about the mirrors associated with a particular source VFS.

Synopsis

CLI:

filestorage mirror show-group -sourcevfsname source_VFS_name -sinkvfsname sink_VFS_name

GUI: Navigate to the File Storage → Mirror node. Select a mirror from the table and run the Show Group command from the drop-down menu of the action pane.

Description

The filestorage mirror show-group command displays the following information about the mirrors associated with a particular source VFS:

Options

-sourcevfsname source_VFS_name

This is the name of the source VFS for which mirror information is to be displayed.

-sinkvfsname sink_VFS_name

This is the name of one of the source VFS's mirror VFSs.

Example

The following example displays information about the mirrors of a source VFS named san, with one mirror named san.m1:

spinserver::> filestorage mirror show-group -sourcevfsname san -sinkvfsname san.m1
Source VFS        Sink VFS        Source SP Sink SP   Sink Ver Status  
                                                                       
san              san.m1           pool0     pool1     2550018  online    
san              san.m3           pool0     pool19    2550018  online    
san              san.m0           pool0     pool0     2550018  online    
san              san.m5           pool0     pool15    2550018  online    
san              san.m4           pool0     pool14    2550018  online    
san              san.m2           pool0     pool99    2550018  online    

File Storage Scheduler Commands

Name

File Storage Scheduler Commands -- 

The filestorage scheduler subnode includes the following leaf nodes:


File Storage Scheduler Jobs Commands

Name

File Storage Scheduler Jobs Commands -- 

The filestorage scheduler jobs leaf node includes the following commands:


filestorage scheduler jobs cleanup

Name

filestorage scheduler jobs cleanup -- Use the filestorage scheduler jobs cleanup command to remove SpinShots and mirror replicas associated with a specified VFS Scheduler job.

Synopsis

CLI:

filestorage scheduler jobs cleanup -task task_name -schedule schedule_name

GUI: Navigate to the File Storage → Scheduler → Jobs node, then select a job from the table and run the Cleanup command from the drop-down menu of the action pane.

Description

The filestorage scheduler jobs cleanup command cleans up (that is, removes) SpinShots and mirror replicas that are associated with a specified VFS Scheduler job.

Options

-task task_name

This specifies the name of the task associated with the job that is to be cleaned up.

-schedule schedule_name

This specifies the name of the schedule associated with the job that is to be cleaned up.

Example

The following example cleans up all SpinShots or mirror replicas associated with a job that includes a task named spinshotUsers and a schedule named halfHour:

spinserver::> filestorage scheduler jobs cleanup -task spinshotUsers -schedule halfHour

filestorage scheduler jobs delete

Name

filestorage scheduler jobs delete -- Use the filestorage scheduler jobs delete command to delete a VFS Scheduler job.

Synopsis

CLI:

filestorage scheduler jobs delete -task task_name -schedule schedule_name

GUI: Navigate to the File Storage → Scheduler → Jobs node, then select a job from the table and run the Delete command from the drop-down menu of the action pane.

Description

The filestorage scheduler jobs delete command deletes a VFS Scheduler job. In VFS Scheduler terms, a job is a task that runs on a particular schedule.

Options

-task task_name

This specifies the name of the task associated with the job that is to be deleted.

-schedule schedule_name

This specifies the name of the schedule associated with the job that is to be deleted.

Example

The following example deletes a job that is associated with a task named make_spinshots and a schedule named every_hour:

spinserver::> filestorage scheduler jobs delete -task make_spinshots -schedule every_hour

filestorage scheduler jobs modify

Name

filestorage scheduler jobs modify -- Use the filestorage scheduler jobs modify command to modify a VFS Scheduler job.

Synopsis

CLI:

filestorage scheduler jobs new -task task_name -schedule schedule_name -autorun {true | false}

GUI: Navigate to the File Storage → Scheduler → Jobs node, then select the appropriate schedule from the table and run the Show command from the drop-down menu of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.

Description

The filestorage scheduler jobs modify command creates a VFS Scheduler job. In VFS Scheduler terms, a job is a task that runs on a particular schedule.

Options

-task task_name

This is the name of the task associated with the job that is to be created.

-schedule schedule_name

This is the name of the schedule associated with the job that is to be created.

-autorun {true | false}

This determines whether or not the job is automatically run after it is created.

Example

The following example disables a job that is associated with a task named make_spinshots and a schedule named every_hour:

spinserver::> filestorage scheduler jobs new -task make_spinshots -schedule every_hour -autorun false

filestorage scheduler jobs new

Name

filestorage scheduler jobs new -- Use the filestorage scheduler jobs new command to create a VFS Scheduler job.

Synopsis

CLI:

filestorage scheduler jobs new -task task_name -schedule schedule_name -autorun {true | false}

GUI: Navigate to the File Storage → Scheduler → Jobs node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed and click Create.

Description

The filestorage scheduler jobs new command creates a VFS Scheduler job. In VFS Scheduler terms, a job is a task that runs on a particular schedule.

Options

-task task_name

This is the name of the task associated with the job that is to be created.

-schedule schedule_name

This is the name of the schedule associated with the job that is to be created.

-autorun {true | false}

This determines whether or not the job is automatically run after it is created.

Example

The following example creates and automatically runs a new job that is associated with a task named make_spinshots and a schedule named every_hour:

spinserver::> filestorage scheduler job new -task make_spinshots -schedule every_hour -autorun true

filestorage scheduler jobs show

Name

filestorage scheduler jobs show -- Use the filestorage scheduler jobs show command to display information about VFS Scheduler jobs.

Synopsis

CLI:

filestorage scheduler jobs show [-task task_name -schedule schedule_name]

GUI: Navigate to the File Storage → Scheduler → Jobs node. To display information about a particular job, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The filestorage scheduler jobs show command displays information about all VFS Scheduler jobs or about a specified VFS Scheduler job. The information includes the following:

Use the command with the -task and -schedule arguments to display information about a specific job, or without arguments to display information about all jobs.

Options

[-task task_name]

This specifies the name of the task associated with the job whose information is to be displayed.

[-schedule schedule_name]

This specifies the name of the schedule associated with the job whose information is to be displayed.

Example

The following example displays information about all VFS Scheduler jobs:

spinserver::> filestorage scheduler jobs show 

  Task          Schedule      Autorun?    Last Execution             Status        
all_1           weekly          true       7/6/03 12:00 AM   Completed Successfully
all_2           daily           true       7/11/03 12:00 AM  Completed Successfully
all_3           hourly          true       7/11/03 3:00 PM   Completed Successfully

filestorage scheduler jobs testrun

Name

filestorage scheduler jobs testrun -- Use the filestorage scheduler jobs testrun command to run a test of a VFS Scheduler job immediately, without having to wait for the next scheduled time interval.

Synopsis

CLI:

filestorage scheduler jobs testrun -task task_name -schedule schedule_name

GUI: Navigate to the File Storage → Scheduler → Jobs node, then select the appropriate schedule from the table and run the Test command from the drop-down menu of the action pane.

Description

The filestorage scheduler jobs testrun command runs a specified VFS Scheduler job immediately, enabling you to test the job without having to wait for the next scheduled time interval.

Options

-task task_name

This is the name of the task associated with the job that is to be tested.

-schedule schedule_name

This is the name of the schedule associated with the job that is to be tested.

Example

The following example tests (that is, immediately runs) a job that is associated with a task named make_spinshots and a schedule named every_hour:

spinserver::> filestorage scheduler job testrun -task make_spinshots -schedule every_hour

File Storage Scheduler Schedules Commands

Name

File Storage Scheduler Schedules Commands -- 

The filestorage scheduler schedules leaf node includes the following commands:


filestorage scheduler schedules delete

Name

filestorage scheduler schedules delete -- Use the filestorage scheduler schedules delete command to delete a VFS Scheduler schedule.

Synopsis

CLI:

filestorage scheduler schedules delete -name schedule_name

GUI: Navigate to the File Storage → Scheduler → Schedules node, then select the appropriate schedule from the table and run the Delete command from the drop-down menu of the action pane.

Description

The filestorage scheduler schedules delete command deletes a specified VFS Scheduler schedule.

Options

-name schedule_name

This is the name of the schedule that is to be deleted.

Example

The following example deletes a schedule named every_month:

spinserver::> filestorage scheduler schedules delete -name every_month

filestorage scheduler schedules modify

Name

filestorage scheduler schedules modify -- Use the filestorage scheduler schedules modify command to modify a VFS Scheduler schedule.

Synopsis

CLI:

filestorage scheduler schedule modify -name schedule_name [-minutes minutes] [-hours hours] [-months months] [-dom days_of_month] [-dow days_of_week]

GUI: Navigate to the File Storage → Scheduler → Schedules node, then select the appropriate schedule from the table and run the Show command from the drop-down menu of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.

Description

The filestorage scheduler schedules modify command modifies a VFS Scheduler schedule.

Options

-name schedule_name

This is the name of the schedule that is to be modified.

[-minutes minutes]

This specifies the minute value at which the schedule is to run. If you specify a single value, it must be specified as an integer between 0 and 59, inclusive. If the new schedule does not require a specific minute value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

[-hours hours]

This specifies the hour value at which the schedule is to run. This value must be specified as an integer between 0 (midnight) and 23 (11:00 p.m.), inclusive. If the new schedule does not require a specific hour value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

[-months months]

This specifies the month or months in which the schedule is to run. Possible values include January, February, March, April, May, June, July, August, September, October, November, and December. If the new schedule does not require a specific month value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

[-dom days_of_month]

This specifies the days of the month on which the schedule is to run. If the new schedule does not require a specific day-of-the-month value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

[-dow days_of_week]

This specifies the days of the week on which the schedule is to run. Possible values include Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. If the new schedule does not require a specific day-of-the-week value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

Note: These expressions can be used only in the CLI. To specify a time range or interval in the GUI, select the appropriate values from the drop-down boxes.

Example

The following example modifies a schedule named every_month so that it runs on the fifteenth day of each month at 5:00 p.m.:

spinserver::> filestorage scheduler schedules modify  -name every_month -minutes 0 -hours 17 -dom 15

filestorage scheduler schedules new

Name

filestorage scheduler schedules new -- Use the filestorage scheduler schedules new command to create a VFS Scheduler schedule.

Synopsis

CLI:

filestorage scheduler schedules new -name schedule_name -minutes minutes -hours hours -months months -dom days_of_month -dow days_of_week

GUI: Navigate to the File Storage → Scheduler → Schedules node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed and click Create.

Description

The filestorage scheduler schedules new command creates a VFS Scheduler schedule. Each schedule is assigned one of the following time types: minutely, hourly, daily, weekly, monthly, or yearly. The type is automatically determined, and is displayed in the output of the filestorage scheduler schedules show command.

Options

-name schedule_name

This is the name of the schedule that is to be modified.

-minutes minutes

This specifies the minute value at which the schedule is to run. If you specify a single value, it must be specified as an integer between 0 and 59, inclusive. If the new schedule does not require a specific minute value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

-hours hours

This specifies the hour value at which the schedule is to run. This value must be specified as an integer between 0 (midnight) and 23 (11:00 p.m.), inclusive. If the new schedule does not require a specific hour value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

-months months

This specifies the month or months in which the schedule is to run. Possible values include January, February, March, April, May, June, July, August, September, October, November, and December. If the new schedule does not require a specific month value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

-dom days_of_month

This specifies the days of the month on which the schedule is to run. If the new schedule does not require a specific day-of-the-month value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

-dow days_of_week

This specifies the days of the week on which the schedule is to run. Possible values include Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. If the new schedule does not require a specific day-of-the-week value, specify an asterisk (*) as the value of this option. You can specify multiple values as follows:

Note: These expressions can be used only in the CLI. To specify a time range or interval in the GUI, select the appropriate values from the drop-down boxes.

Example

The following example creates a schedule named every_month that runs on the first day of each month at 8:00 p.m.:

spinserver::> filestorage scheduler schedule new -name every_month -minutes 0 -hours 20 -months * -dom 1 -dow *

filestorage scheduler schedules show

Name

filestorage scheduler schedules show -- Use the filestorage scheduler schedules show command to display information about VFS Scheduler schedules.

Synopsis

CLI:

filestorage scheduler schedules show [-name schedule_name]

GUI: Navigate to the File Storage → Scheduler → Schedules node. To display information about a specific schedule, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The filestorage scheduler schedules show command displays information about all VFS Scheduler schedules or a specified VFS Scheduler schedule. The information includes the following:

To display information about all schedules, use the command without any arguments; to display information about a specific schedule, use the command with the -name argument.

Options

[-name schedule_name]

This is the name of the schedule about which information is to be displayed.

Example

The following example displays information about all schedules:

spinserver::> filestorage scheduler schedules show 
     Name         Minutes   Hours    Months  DaysOfMont DaysOfWeek
                                                          
                                                                     
daily                0        0        *        *          *         
hourly               35       *        *        *          *         
monthly              0        0        *        1          *         
weekly               0        0        *        *          Sunday    
yearly               0        0        January  1          *         
every_month          0        20       *        1          *

The following example displays information about a schedule named daily:

spinserver::> filestorage scheduler schedules show -name daily
   Name          daily                                   
   Minutes       0                                       
   Hours         0                                       
   Months        *                                       
   DaysOfMonth   *                                       
   DaysOfWeek    *                                       

File Storage Scheduler Tasks Commands

Name

File Storage Scheduler Tasks Commands -- 

The filestorage scheduler tasks leaf node includes the following commands:


filestorage scheduler tasks cleanup

Name

filestorage scheduler tasks cleanup -- Use the filestorage scheduler tasks cleanup command to delete all SpinShots or mirror replicas created by a VFS Scheduler task.

Synopsis

CLI:

filestorage scheduler tasks cleanup -name task_name

GUI: Navigate to the File Storage → Scheduler → Tasks node, then select the appropriate task from the table and run the Cleanup command from the drop-down menu of the action pane.

Description

The filestorage scheduler tasks cleanup command deletes all SpinShots or mirror replicas created by a VFS Scheduler task. If the task is a SpinShot task, the command deletes all SpinShots that were created by the task. If the task is a mirror task, the command deletes all replicas that were created by the task.

Options

-name task_name

This is the name of the task whose SpinShots or mirror replicas are to be cleaned up.

Example

The following example cleans up all mirror replicas associated with a mirror VFS Scheduler task named mirrorAdmin:

spinserver::> filestorage scheduler tasks cleanup -name mirrorAdmin

filestorage scheduler tasks delete

Name

filestorage scheduler tasks delete -- Use the filestorage scheduler tasks delete command to delete a VFS Scheduler task.

Synopsis

CLI:

filestorage scheduler tasks delete -name task_name

GUI: Navigate to the File Storage → Scheduler → Tasks node, then select the appropriate task from the table and run the Delete command from the drop-down menu of the action pane.

Description

The filestorage scheduler tasks delete command deletes a specified VFS Scheduler task.

Options

-name task_name

This is the name of the task to be deleted.

Example

The following example deletes a VFS Scheduler task named mirrorAdmin:

spinserver::> filestorage scheduler tasks delete -name mirrorAdmin

filestorage scheduler tasks modify

Name

filestorage scheduler tasks modify -- Use the filestorage scheduler tasks modify command to modify a VFS Scheduler task.

Synopsis

CLI:

filestorage scheduler tasks modify -name task_name [-type VFS_type] [-vfs VFS_name] [-limit limitation]

GUI: Navigate to the File Storage → Scheduler → Tasks node, then select a task from the table and run the Show command from the drop-down menu of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.

Description

The filestorage scheduler tasks modify command modifies a specified VFS Scheduler task.

Options

-name task_name

This is the name of the task that is to be modified.

[-type VFS_type]

This is the VFS type of the task. Possible values include mirror and spinshot.

[-vfs VFS_name]

This specifies the name or names of the VFS or VFSs associated with the task. You can specify multiple VFSs as follows:

You can specify VFSs that are not to be included by using the NOT{expression} syntax. For instance, to specify all VFSs named dept.* except for the VFS named dept.eng, use the following syntax:

dept.*, NOT{dept.eng}
[-limit limitation]

This is the number of mirror replicas or SpinShots that you want to keep. This value must be specified as a positive integer (1 or greater). When the limitation is reached, the task begins to discard the oldest mirror replicas or SpinShots as it creates new ones.

Example

The following example modifies a VFS Scheduler task named mirrorAdmin so that it creates a SpinShot of the VFS named Admin with a limitation of 30 replicas:

spinserver::> filestorage scheduler tasks modify -name mirrorAdmin -type spinshot -vfs Admin -limit 30

filestorage scheduler tasks new

Name

filestorage scheduler tasks new -- Use the filestorage scheduler tasks new command to create a VFS Scheduler task.

Synopsis

CLI:

filestorage scheduler tasks new -name task_name -type VFS_type -vfs VFS_name -limit limitation

GUI: Navigate to the File Storage → Scheduler → Tasks node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed and click Create.

Description

The filestorage scheduler tasks new command creates a specified VFS Scheduler task.

Options

-name task_name

This is the name of the task that is to be created.

-type VFS_type

This is the VFS type of the task. Possible values include mirror and spinshot.

-vfs VFS_name

This specifies the name of the VFS associated with the task. You can specify multiple VFSs as follows:

You can specify VFSs that are not to be included by using the NOT{expression} syntax. For instance, to specify all VFSs named dept.* except for the VFS named dept.eng, use the following syntax:

dept.*, NOT{dept.eng}
-limit limitation

This specifies the number of mirror replicas or SpinShots that you want to keep. This value must be specified as a positive integer (1 or greater). When the limitation is reached, the task begins to discard the oldest mirror replicas or SpinShots as it creates new ones.

Example

The following example creates a VFS Scheduler task named mirrorAdmin so that it creates a mirror of the VFS named Admin with a limitation of 5 replicas:

spinserver::> filestorage scheduler tasks new -name mirrorAdmin -type mirror -vfs Admin -limit 5

filestorage scheduler tasks show

Name

filestorage scheduler tasks show -- Use the filestorage scheduler tasks show command to display information about VFS Scheduler tasks.

Synopsis

CLI:

filestorage scheduler tasks show [-name task_name]

GUI: Navigate to the File Storage → Scheduler → Tasks node. To display information about a specific task, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The filestorage scheduler tasks show command displays information about all VFS Scheduler tasks or about a specified VFS Scheduler task. The information includes the following:

To display information about all tasks, use the command without any arguments; to display information about a specific task, use the command with the -name argument.

Options

[-name task_name]

This is the name of the task about which information is to be displayed.

Example

The following example displays information about all VFS Scheduler tasks:

spinserver::> filestorage scheduler tasks show 
Name            Type       VFS            Limitation

mirrorAdmin     mirror      Admin          5
ssAdmin         spinshot   Admin          31        

The following example displays information about a VFS Scheduler task named mirrorAdmin:

spinserver::> filestorage scheduler tasks show -name mirrorAdmin
   Name         mirrorAdmin 
   Type         mirror                                  
   VFS          Admin 
   Limitation   5

File Storage VFS Commands

Name

File Storage VFS Commands -- 

The filestorage vfs subnode includes the following leaf nodes:


filestorage vfs copy

Name

filestorage vfs copy -- Use the filestorage vfs copy command to copy an existing virtual file system (VFS).

Synopsis

CLI:

filestorage vfs copy -vfsname VFS_name -copyvfsname name_of_VFS_copy -copyspname storage_pool_name

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Copy command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed and click Copy.

Description

The filestorage vfs copy command creates a read-write copy of the specified virtual file system on the specified storage pool.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be copied.

-copyvfsname name_of_VFS_copy

This is the name of the copied VFS.

-copyspname storage_pool_name

This is the name of the storage pool on which the copy is to be made.

Example

The following example makes a read-write copy of the virtual file system named vfs1. The copy is named vfs1.copy and is located on the storage pool named pool2.

spinserver::> filestorage vfs copy -vfsname vfs1 -copyvfsname vfs1.copy -copyspname pool2

filestorage vfs delete

Name

filestorage vfs delete -- Use the filestorage vfs delete command to delete a virtual file system.

Synopsis

CLI:

filestorage vfs delete -vfsname VFS_name

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Delete command from the drop-down menu of the action pane.

Description

The filestorage vfs delete command identifies a virtual file system by its name and removes it from the system.

Options

-vfsname VFS_name

This is the virtual file system name.

Example

The following example deletes the virtual file system named vfs1.

spinserver::> filestorage vfs delete -vfsname vfs1

filestorage vfs modify

Name

filestorage vfs modify -- Use the filestorage vfs modify command to modify the minimum quota, maximum quota, user type, domain, user, or group of an existing virtual file system.

Synopsis

CLI:

filestorage vfs modify -vfsname VFS_name [-usertype user_type] [-domain domain_name] [-user user_name] [-group group_name] [-qmin quota_minimum] [-qmax quota_maximum] [-freespacealarm free_space_alarm_threshold] [-rulesetname rule_set_name] [-virusscanrw {true | false}] [-virusscanro {true | false}] [-showspinshot {true | false}] [-restrictedacl {true | false}]

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Show command from the drop-down menu of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.

Description

The filestorage vfs modify command identifies a virtual file system by its name and modifies its settings.

Options

-vfsname VFS_name

This is the name of the virtual file system.

-usertype user_type

This parameter controls how SpinManager interprets the values of the -domain, -user, and -group parameters. Possible types include SPIN, NFS, CIFS, and NFS-Kerberos. Use the SPIN type if an NIS or CIFS domain is not configured or available. If you create an NFS or CIFS virtual server or VFS, an NIS or CIFS domain must already be configured on the SpinServer. The CIFS user type is used only for CIFS or mixed-security (NFS and CIFS) environments. If the parameter is set to NFS-Kerberos, you must specify a Kerberos realm name as the value of the -domain parameter and a Kerberos principal name as the value of the -user parameter; in this case, the value of the -group parameter is disregarded and can be omitted from the command. If the NFS-Kerberos user type is specified, the ownership of the VFS is assigned to the user that is mapped to the Kerberos principal name specified by the value of the -user parameter. The virtual server must have a NIS domain or other mapping mechanism (for instance, a pluggable authentication module) associated with it, and a Kerberos-NIS mapping that matches the Kerberos principal name must exist.

-domain domain_name

This is the name of the domain in which the user and group names are interpreted. If the -usertype parameter is set to SPIN, this is a numeric domain ID. If the parameter is set to NFS, this is the name of a NIS domain (configured by using the spinaccess nfs domains commands). If the parameter is set to CIFS, this is the name of a CIFS domain (configured by using the spinaccess cifs domains commands). If the parameter is set to NFS-Kerberos, this is the name of a Kerberos domain.

-user user_name

This is the user name or ID to be set as the owner of the root of the VFS. If the -usertype parameter is set to SPIN, this is a numeric user ID; if the parameter is set to NFS, CIFS, or NFS-Kerberos, this is the name of a user in the relevant domain.

-group group_name

This is the group name or ID to be set as the group owner of the root of the VFS. If the -usertype parameter is set to SPIN, this is a numeric group ID; if the parameter is set to NFS or CIFS, this is the name of a group in the relevant domain. If the parameter is set to NFS-Kerberos, this value is discarded and can be omitted from the command.

-qmin quota_minimum

This is the minimum quota specified in MB.

-qmax quota_maximum 

This is the maximum quota specified in MB.

-freespacealarm free_space_alarm_threshold

This is the percentage of VFS free space remaining before the free-space alarm is triggered. Possible values are integers from 1 to 50, or 0 to disable the free-space alarm.

-rulesetname rule_set_name

This specifies the name of the export rule set that is to be applied to the VFS.

-virusscanrw {true | false}

This specifies whether virus scanning is enabled on read-write VFSs. The default is false.

-virusscanro {true | false}

This specifies whether virus scanning is enabled on read-only VFSs (for instance, SpinShots and mirrors of a parent read-write VFS). The default is false.

-showspinshot {true | false}

This specifies whether the VFS's .spinshot directory is visible to clients. The default is true.

-restrictedacl {true | false}

This specifies whether CIFS ACLs are used (false) or not used (true) on files on the VFS. The default is false (that is, ACLs are used). If CIFS ACLs are not used, UNIX mode bits are the only permissions set on files on the VFS, and attempting to modify ACLs from a CIFS client results only in changes to the mode bits.

Example

The following example modifies the settings for the virtual file system named vfs1. The VFS belongs to a CIFS user with the user name chris. The domain is ENG and the group is ENG12. The user is given a minimum quota of 5000 MB and a maximum quota of 10000 MB. The free-space alarm is triggered when only 10 percent of free space remains on the VFS. An export rule set named rs1 is applied to the VFS. Virus scanning is enabled on the parent read-write VFS but disabled on any read-only VFSs (SpinShots or mirrors) of which this VFS is the parent. The .spinshot directory is not visible to clients. CIFS ACLs are not used on the VFS.

spinserver::> filestorage vfs modify -vfsname vfs1 -usertype CIFS -domain ENG -user chris -group ENG12 -qmin 5000 -qmax 10000 -freespacealarm 10 -rulesetname rs1 -virusscanrw true -virusscanro false  -showspinshot false -restrictedacl true

filestorage vfs mount

Name

filestorage vfs mount -- Use the filestorage vfs mount command to mount a virtual file system.

Synopsis

CLI:

filestorage vfs mount -vfsname VFS_name -mountpath mount_path -mounttype {context | explicit | mirror | spinshot} -expoverride {true | false}

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Mount command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed and click Mount.

Description

The filestorage vfs mount command associates a virtual file system path name with the virtual file system name.

Options

-vfsname VFS_name

This is the virtual file system name.

-mountpath mount_path

This is the path to access the VFS from root (/).

-mounttype {context | explicit | mirror | spinshot}

This is the type of VFS that is to be mounted. Possible values include context for a VFS that assumes the context of its parent mount point (read-write or read-only), explicit for a VFS that is read-write regardless of the context of its parent VFS (for instance, if you mount a read-write VFS below a VFS mirror), mirror for a read-only mirror, and spinshot for a read-only SpinShot. The default is context.

-expoverride {true | false}

This specifies whether the VFS's associated export rule set is overridden. The default is false. The following rules apply to export rules when a VFS is mounted:

Example

The following example mounts the virtual file system named vfs1 at the mount path to /vfs1 with a mount type of context. The associated export rule set is not overridden.

spinserver::> filestorage vfs mount -vfsname vfs1 -mountpath /vfs1 -mounttype context -expoverride false

filestorage vfs move

Name

filestorage vfs move -- Use the filestorage vfs move command to move an existing virtual file system (VFS).

Synopsis

CLI:

filestorage vfs move -vfsname VFS_name -spname storage_pool_name

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Move command from the drop-down menu of the action pane. Enter the appropriate value into the table that is displayed and click Move.

Description

The filestorage vfs move command moves the specified virtual file system to the specified storage pool.

If a read-write VFS that has associated SpinShots or mirrors is moved, the SpinShots and mirrors remain in their original locations. It is recommended that you move or delete any SpinShots or mirrors that are associated with the parent read-write VFS to avoid potential confusion and to ensure efficient use of storage.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to be moved.

-spname storage_pool_name

This is the name of the storage pool to which the VFS is to be moved.

Example

The following example moves a virtual file system named vfs1 to a storage pool named pool2.

spinserver::> filestorage vfs move -vfsname vfs1 -spname pool2

filestorage vfs new

Name

filestorage vfs new -- Use the filestorage vfs new command to create a new virtual file system.

Synopsis

CLI:

filestorage vfs new -vfsname VFS_name -vsname virtual_server_name -spdevid storage_pool_ID -usertype user_type -domain domain_name -user user_name -group group_name -qmin quota_minimum -qmax quota_maximum -freespacealarm free_space_alarm_threshold -mounttype {context | explicit | mirror | spinshot} -mountpath mount_path -rulesetname rule_set_name -virusscanrw {true | false} -virusscanro {true | false} -showspinshot {true | false} -restrictedacl {true | false}

GUI: Navigate to the File Storage → Virtual File Systems node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed and click Create.

Description

The filestorage vfs new command creates a new virtual file system.

Options

-vfsname VFS_name

This is the virtual file system name.

-vsname virtual_server_name

This is the virtual server name.

-spdevid storage_pool_ID

This is the ID of the storage pool.

-usertype user_type

This parameter controls how SpinManager interprets the values of the -domain, -user, and -group parameters>. Possible types include SPIN, NFS, CIFS, and NFS-Kerberos. Use the SPIN type if a NIS or CIFS domain is not configured or available. If you create an NFS or CIFS virtual server or VFS, a NIS or CIFS domain must already be configured on the SpinServer. The CIFS user type is used only for CIFS or mixed-security (NFS and CIFS) environments. If the parameter is set to NFS-Kerberos, you must specify a Kerberos realm name as the value of the -domain parameter and a Kerberos principal name as the value of the -user parameter; in this case, the value of the -group parameter is disregarded and can be omitted from the command. If the NFS-Kerberos user type is specified, the ownership of the VFS is assigned to the user that is mapped to the Kerberos principal name specified by the value of the -user parameter. The virtual server must have a NIS domain or other mapping mechanism (for instance, a pluggable authentication module) associated with it, and a Kerberos-NIS mapping that matches the Kerberos principal name must exist.

-domain domain_name

This is the name of the domain in which the user and group names are interpreted. If the -usertype parameter is set to SPIN, this is a numeric domain ID. If the parameter is set to NFS, this is the name of a NIS domain (configured by using the spinaccess nfs domains commands). If the parameter is set to CIFS, this is the name of a CIFS domain (configured by using the spinaccess cifs domains commands). If the parameter is set to NFS-Kerberos, this is the name of a Kerberos domain.

-user user_name

This is the user name or ID to be set as the owner of the root of the VFS. If the -usertype parameter is set to SPIN, this is a numeric user ID; if the parameter is set to NFS, CIFS, or NFS-Kerberos, this is the name of a user in the relevant domain.

-group group_name

This is the group name or ID to be set as the group owner of the root of the VFS. If the -usertype parameter is set to SPIN, this is a numeric group ID; if the parameter is set to NFS or CIFS, this is the name of a group in the relevant domain. If the parameter is set to NFS-Kerberos, this value is discarded and can be omitted from the command.

-qmin quota_minimum 

This is the minimum quota specified in MB.

-qmax quota_maximum 

This is the maximum quota specified in MB.

-freespacealarm free_space_alarm_threshold

This is the percentage of VFS free space remaining before the free-space alarm is triggered. Possible values are integers from 1 to 50, or 0 to disable the free-space alarm.

-mounttype {context | explicit | mirror | spinshot}

This is the type of VFS that is to be mounted. Possible values include context for a VFS that assumes the context of its parent mount point (read-write or read-only), explicit for a VFS that is read-write regardless of the context of its parent VFS (for instance, if you mount a read-write VFS below a VFS mirror), mirror for a read-only mirror, and spinshot for a read-only SpinShot. The default is context.

-mountpath mount_path

This is the mount path of the VFS.

-rulesetname rule_set_name

This specifies the name of the export rule set that is to be applied to the VFS. To have the new VFS inherit the export rule set of the VFS that it is mounted on, specify a value of inherit for this parameter. This is a reserved value and applies only to the filestorage vfs new command, and only when the VFS is mounted at the same time it is created.

-virusscanrw {true | false}

This specifies whether virus scanning is enabled on read-write VFSs. The default is false.

-virusscanro {true | false}

This specifies whether virus scanning is enabled on read-only VFSs (for instance, SpinShots and mirrors of a parent read-write VFS). The default is false.

-showspinshot {true | false}

This specifies whether the .spinshot directory is visible to clients. The default is true.

-restrictedacl {true | false}

This specifies whether CIFS ACLs are used (false) or not used (true) on files on the VFS. The default is false (that is, ACLs are used). If CIFS ACLs are not used, UNIX mode bits are the only permissions set on files on the VFS, and attempting to modify ACLs from a CIFS client results only in changes to the mode bits.

Example

The following example creates a virtual file system named marketing. The VFS uses a virtual server named vs1 and a storage pool named pool0. The minimum quota for the VFS is 1048576 MB, and the maximum quota is 2097152 MB. The free-space alarm is triggered when only 5 percent of free space remains on the VFS. The initial user is a CIFS user with the user name chris. The domain is set to ENG and the group is set to ENG12. The VFS has the same read-write properties as the VFS on which it is mounted and is mounted at /dept. The export rule set is inherited from the VFS on which the new VFS is mounted (dept). Virus scanning is enabled by default on read-write VFSs but not on read-only VFSs. The .spinshot directory is visible to clients. CIFS ACLs are used on files on the VFS.

spinserver::> filestorage vfs new -vsname vs1 -spdevid pool0 -vfsname marketing -qmin 1048576 -qmax 2097152 -freespacealarm 5 -usertype CIFS -domain ENG -user chris -group ENG12 -mounttype context -mountpath /dept -rulesetname inherit -virusscanrw true -virusscanro false -showspinshot true -restrictedacl false

filestorage vfs resetexportruleset

Name

filestorage vfs resetexportruleset -- Use the filestorage vfs resetexportruleset command to change the export rule set on a virtual file system (VFS) and to change the export rule set recursively down a chain of virtual file systems (VFSs).

Synopsis

CLI:

filestorage vfs resetexportruleset -vfsname VFS_name -rulesetname rule_set_name -expoverride {true | false}

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Reset Export Ruleset command from the drop-down menu of the action pane. Enter the appropriate value into the table that is displayed and click Reset Export Ruleset.

Description

The filestorage vfs resetexportruleset command propagates changes to export rule sets recursively down a chain of VFSs. The export rule set is changed on the VFS specified by the value of the -vfsname parameter; it can also be changed on all VFSs mounted below that VFS.

Options

-vfsname VFS_name

This is the name of the virtual file system that is to have its export rule set changed.

-rulesetname rule_set_name

This is the name of the export rule set that is to be applied to the VFS.

-expoverride {true | false}

This specifies how to handle export rule sets on subordinate VFSs that are not using the export rule set named none. Subordinate VFSs are VFSs that are mounted below the VFS specified by the value of the -vfsname parameter. Each subordinate VFS is evaluated and changed as follows:

Example

The following example resets the rule set for a virtual file system named vfs1 to a rule set named newRS. The new rule set is applied to all VFSs mounted below vfs1 regardless of their current rule sets.

spinserver::> filestorage vfs resetexportruleset -vfsname vfs1 -rulesetname newRS -expoverride true

filestorage vfs show

Name

filestorage vfs show -- Use the filestorage vfs show command to display configuration details of a virtual file system.

Synopsis

CLI:

filestorage vfs show [-vfsname VFS_name]

GUI: Navigate to the File Storage → Virtual File Systems node. To display information about a specific VFS, select it from the table and run the Show command from the drop-down menu of the action pane.

Description

The filestorage vfs show command identifies a virtual file system by its virtual file system name. When identification of a specific VFS is made, the following information is displayed about the virtual file system. A subset of this information is displayed if you run the command without using the -vfsname parameter to specify a VFS name.

When issued without the -vfsname parameter, the filestorage vfs show command lists only read-write VFSs. To display a list of all VFSs on a SpinServer system, including read-only VFSs such as SpinShots and mirrors, use the filestorage vfs show-all command.

Options

[-vfsname VFS_name]

This is the virtual file system name.

Example

The following example displays information about all read-write virtual file systems.

spinserver::> filestorage vfs show 
VFS                  Fam MaxQ (MB)  Used (MB)   Storage   SP Avail (MB) Status
                     Siz                          Pool


root.vs0             1   10         1          pool0      47806         online
root.vs1             1   10         1          pool1      63883         online
test                 1   10         1          pool0      47806         online
test.cp              1   10         1          pool0      47806         online
vs0pool0_10          1   10         1          pool0      47806         online
vs0pool0_11          1   10         1          pool0      47806         online
vs0pool0_12          1   10         1          pool0      47806         online
vs0pool0_13          1   10         1          pool0      47806         online
vs0pool0_14          1   10         1          pool0      47806         online
vs0pool0_15          1   10         1          pool0      47806         online
vs0pool0_16          1   10         1          pool0      47806         online

The following example displays detailed information about the virtual file system named root.vs0.

spinserver::> filestorage vfs show -vfsname root.vs0
   VFS                              root.vs0                                
   Family Name                      root.vs0                                
   Family Size                      2                                       
   Virtual Server                   vs0                                     
   VFS ID                           1024                                    
   Type                             read-write                              
   Create Time                      7/14/03 11:54 AM                        
   Mounted From                     root.vs0                                
   Mount Type
   Mount Path                       /                                       
   Minimum Quota (MB)               10                                      
   Maximum Quota (MB)               10                                      
   Free Space Alarm Threshold (%)   0                                       
   Used (MB)                        1                                       
   Storage Pool                     pool0 
   SP Avail (MB)                    129690                                  
   User Type of root FID            SPIN                                    
   Domain of root FID               0                                       
   User of root FID                 0                                       
   Group of root FID                0                                       
   Export Ruleset Name              default_ruleset                         
   VirusScan for R-W                true                                    
   VirusScan for R-O                true                                    
   Show Spinshot Directory          false
   Status                           online                                  
   Status Error

filestorage vfs show-access

Name

filestorage vfs show-access -- Use the filestorage vfs show-access command to display information about export rule sets for one or more virtual file systems (VFSs).

Synopsis

CLI:

filestorage vfs show-access -vfsname VFS_name

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show command from the drop-down menu of the action pane.

Description

The filestorage vfs show-access command displays information about export rule sets for one or more VFSs.

Options

-vfsname VFS_name

This is the virtual file system name.

Example

The following example displays the export rule set information for all VFSs.

spinserver::> filestorage vfs show-access 
        VFS             VFS ID       Export   
                                    Ruleset   
                                      Name    

vfs1                    1027        rs1
vfs2                    2023        rs1
vfs3                    2024        none

filestorage vfs show-all

Name

filestorage vfs show-all -- Use the filestorage vfs show-all command to display a listing of all virtual file systems (VFSs), including read-only VFSs such as SpinShots and mirrors.

Synopsis

CLI:

filestorage vfs show-all

GUI: Navigate to the File Storage → Virtual File Systems node, then click Show All in the top bar of the action pane.

Description

The filestorage vfs show-all command displays all VFSs, both read-write and read-only.

Options

There are no parameters for this command.

Example

The following example displays all VFSs.

spinserver::> filestorage vfs show-all 
VFS                  Fam MaxQ (MB)  Used (MB)   Storage   SP Avail (MB) Status
                     Siz                          Pool


root.vs0             1   10         1          pool0      47806         online
root.vs1             1   10         1          pool1      63883         online
vs0pool0_11          1   10         1          pool0      47806         online
vs0pool0_12          1   10         1          pool0      47806         online
vs0pool0_13          1   10         1          pool0      47806         online
vs0pool0_14          1   10         1          pool0      47806         online
vs0pool0_15          1   10         1          pool0      47806         online
vs0pool0_16          1   10         1          pool0      47806         online
vs0pool0_17          1   10         1          pool0      47806         online
vs0pool0_18          1   10         1          pool0      47806         online
vs0pool0_19          1   10         1          pool0      47806         online
vs0pool0_20          1   10         1          pool0      47806         online
vs0pool0_21          1   10         1          pool0      47806         online
vs0pool0_22          1   10         1          pool0      47806         online
vs0pool0_23          1   10         1          pool0      47806         online

filestorage vfs show-family

Name

filestorage vfs show-family -- Use the filestorage vfs show-family command to display the read-only virtual file systems (VFSs), such as SpinShots and mirrors, that are associated with a read-write virtual file system.

Synopsis

CLI:

filestorage vfs show-family -vfsname VFS_name

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show Family command from the drop-down menu of the action pane.

Description

The filestorage vfs show-family command displays the following information about the read-only VFSs that are associated with a read-write VFS:

Options

-vfsname VFS_name

This is the virtual file system name.

Example

The following example displays the SpinShots and mirrors for a virtual file system named vfs1.

spinserver::> filestorage vfs show-family -vfsname san
VFS        Type        Mount Path         Create Time            Storage      Status
                                                                  Pool   
                                  
san.67     spinshot   .spinshot/hourly   09/22/2004 8:58 AM       pool0      online 
san.77     spinshot   .spinshot/hourly   09/22/2004 6:23 AM       pool0      online 
san.16     spinshot   .spinshot/weekly   09/12/2004 12:44 AM      pool0      online 
san.m1     mirror     /san               09/22/2004 9:30 AM       pool1      online 
san        read-write /san               07/06/2004 1:32 PM       pool0      online 
san.23     spinshot   .spinshot/hourly   09/22/2004 11:28 AM      pool0      online 
san.19     spinshot   .spinshot/daily    09/22/2004 12:38 AM      pool0      online 
san.m3     mirror     /san               09/22/2004 9:30 AM       pool19     online 
san.m0     mirror     /san               09/22/2004 9:30 AM       pool0      online 
san.m5     mirror     /san               09/22/2004 9:30 AM       pool15     online 
san.m4     mirror     /san               09/22/2004 9:30 AM       pool14     online 
san.36     spinshot   .spinshot/daily    09/15/2004 12:37 AM      pool0      online 
san.m2     mirror     /san               09/22/2004 9:31 AM       pool99     online 

filestorage vfs show-mount

Name

filestorage vfs show-mount -- Use the filestorage vfs show-mount command to display mount-path information for a specific virtual file system or for all virtual file systems.

Synopsis

CLI:

filestorage vfs show-mount [-vfsname VFS_name]

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show command from the drop-down menu of the action pane.

Description

The filestorage vfs show-mount command can be used without the -vfsname parameter to display mount path information about all VFSs in the system or with the -vfsname parameter to display mount path information about a specific VFS. If the VFS name is specified, this command displays the same information as the filestorage vfs show command for the specified VFS name.

Options

[-vfsname VFS_name]

This is the virtual file system name.

Example

The following example displays mount-path information for all virtual file systems.

spinserver::> filestorage vfs show-mount 
VFS       VFS ID    Mount Type Mounted From  Mount Path   Use    Storage    SP Avail                                                           (MB)     Pool      (MB) 
root.vs0   305918                  root.vs0     /           1      sp0       118326       
sp0.ptar0  1255104      context    root.vs0     /sp0.ptar0  67     sp0       118326       
sp0.ptar1  1255105      context    root.vs0     /sp0.ptar1  67     sp0       118326       
sp0.ptar10 1255114      context    root.vs0     /sp0.ptar10 67     sp0       118326       
sp0.ptar11 1255115      context    root.vs0     /sp0.ptar11 67     sp0       118326       
sp0.ptar12 1255116      context    root.vs0     /sp0.ptar12 67     sp0       118326       
sp0.ptar13 1255117      context    root.vs0     /sp0.ptar13 67     sp0       118326       
sp0.ptar14 1255118      context    root.vs0     /sp0.ptar14 67     sp0       118326       
sp0.ptar15 1255119      context    root.vs0     /sp0.ptar15 67     sp0       118326

filestorage vfs show-virusscan

Name

filestorage vfs show-virusscan -- Use the filestorage vfs show-virusscan command to display information about virus scanning for one or more VFSs.

Synopsis

CLI:

filestorage vfs show-virusscan [-vfsname VFS_name]

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show command from the drop-down menu of the action pane.

Description

The filestorage vfs show-virusscan command displays information about virus scanning on VFSs. Use the command without the -vfsname parameter to display virus-scanning information about all VFS or with the -vfsname parameter to display virus-scanning information about a single server. The command displays the following information:

Options

[-vfsname VFS_name]

This is the name of the virtual file system.

Example

The following example displays virus-scan information for al virtual file systems.

spinserver::> filestorage vfs show-virusscan 
        VFS              VServer     VirusSca VirusSca Status 
                                     for R-W  for R-O 

root.vs0             vs0             false    false    online 
root.vs0.2376        vs0             false    false    online 
root.vs0.6240        vs0             false    false    online 
root.vs0.6569        vs0             false    false    online 
vs0pool0_0           vs0             false    false    online 

filestorage vfs show-vs

Name

filestorage vfs show-vs -- Use the filestorage vfs show-vs command to display virtual server information for a specific VFS or for all VFSs.

Synopsis

CLI:

filestorage vfs show-vs [-vfsname VFS_name]

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table that is displayed and run the Show command from the drop-down menu of the action pane.

Description

The filestorage vfs show-vs command can be used without the -vfsname parameter to display the virtual server information about all VFSs in the system or with the -vfsname parameter to display information about a specific VFS. If the VFS name is specified, this command displays the same information as the vfs filestorage show-mount command for the specified VFS.

Options

[-vfsname VFS_name]

This is the name of the virtual file system.

Example

The following example displays the virtual server information for all virtual file systems.

spinserver::> filestorage vfs show-vs 
    VFS        VServer    Storage    VFS ID
                            Pool

m.vfs1       vs0          pool1    1073742857
m.vfs1.32004 vs0          pool1    32004
m.vfs1.32007 vs0          pool1    32007
root.vs0     vs0          pool0    1024
vfs1         vs0          pool0    1033

filestorage vfs spinshot

Name

filestorage vfs spinshot -- Use the filestorage vfs spinshot command to create a one-time SpinShot of an existing virtual file system (VFS).

Synopsis

CLI:

filestorage vfs spinshot -vfsname source_VFS_name -mountpointname mount_point_name

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the SpinShot command from the drop-down menu of the action pane.

Description

The filestorage vfs spinshot command creates a read-only snapshot of the selected virtual file system. The SpinShot is named by the SpinServer. The SpinServer gives the SpinShot the original VFS name and appends a new VFS ID to the name. This combination of original VFS name and the new VFS ID becomes the SpinShot's name. The SpinShot is mounted according to the value specified by the -mountpointname; the SpinShot is then mounted under the source SpinShot at vfs/.spinshot/ spinshot_name. For instance, if you create a SpinShot of a VFS named foo and specify a mount point of bar, the SpinShot is mounted at foo/.spinshot/bar.

Options

-vfsname source_VFS_name

This is the name of the virtual file system that is to have a SpinShot created.

-mountpointname mount_point_name

This is the name of the mount point that is to be created under the ./spinshot directory.

Example

The following example creates a SpinShot the virtual file system named vfs1. The mount point is specified as dataClone, so the SpinShot is mounted at vfs1/.spinshot/dataClone.

spinserver::> filestorage vfs spinshot -vfsname vfs1 -mountpointname dataClone

filestorage vfs unmount

Name

filestorage vfs unmount -- Use the filestorage vfs unmount command to unmount a virtual file system.

Synopsis

CLI:

filestorage vfs unmount -vfsname VFS_name 

GUI: Navigate to the File Storage → Virtual File Systems node, then select the appropriate VFS from the table and run the Unmount command from the drop-down menu of the action pane.

Description

The filestorage vfs unmount command identifies a virtual file system by its virtual file system name and unmounts it.

Options

-vfsname VFS_name

This is the name of the virtual file system.

Example

The following example unmounts the virtual file system named vfs1.

spinserver::> filestorage vfs unmount -vfsname vfs1

Copyright © 2004 Network Appliance, Inc.; copyright © 2003, 2004 Spinnaker Networks, LLC. All rights reserved. Specifications subject to change without notice.